Adds user guide on advanced query classes #406
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a new user guide notebook demonstrating advanced RedisVL query classes (TextQuery, HybridQuery, MultiVectorQuery) and slightly adjusts cleanup formatting in an existing notebook.
- Introduces comprehensive examples for text, hybrid, and multi-vector queries.
- Defines a sample schema and dataset to illustrate query capabilities.
- Replaces a standalone markdown cleanup header with an inline code comment in another guide.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/user_guide/09_advanced_queries.ipynb | New notebook showcasing advanced query classes with schema, data loading, and varied query examples. |
| docs/user_guide/05_hash_vs_json.ipynb | Minor change: removed markdown cleanup header and added a code comment before index deletion. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Collaborator
tylerhutcherson
left a comment
tylerhutcherson
left a comment
There was a problem hiding this comment.
Looks good! 2 small comments to take as you wish:
- In hybrid searches, its best practice to use the normalized BM25 scorer so that final scores are properly balanced prior to weighting.
- At the end in the comparison, it could be good to run the same query through all query types and report the top match and score in a clean table for comparison (ideally something that shows the difference?)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
rbs333
approved these changes
Oct 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a notebook to our RedisVL user guides that demonstrated advanced query classes: TextQuery, HybridQuery, and MultiVectorQuery.